Class MgntAccessSettingManagerImpl

java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.sim.impl.MgntAccessSettingManagerImpl
All Implemented Interfaces:
IPCObject, MgntAccessSettingManager

public class MgntAccessSettingManagerImpl extends IPCObjectImpl implements MgntAccessSettingManager
Information provided by the PKI file:

    \class CMgntAccessSettingManager
    
    \brief CMgntAccessSettingManager is the asa object storage manager class that is used to store and retrieve asa object.
    
    \example network().getDevice("Router0").getAsaMgntAccessManager()
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • deleteIpv4MgntAccessSetting

      public boolean deleteIpv4MgntAccessSetting(AccessProtocol protocol, IPAddress allowedIp, IPAddress allowedMask, String srcNameIf)
      Information provided by the PKI file:
      
          \brief Delete the access configuration that matches protocol, allowed ip address, allowed mask and nameIf
          
          \param protocol, ssh/telnet/http
          \param allowedIp, ip address
          \param allowedMask, mask
          \param srcNameIf, nameIf of the interface that allow remote access
          
          \return bool, value is true if the delete was successful, false if not.
          
              
      Specified by:
      deleteIpv4MgntAccessSetting in interface MgntAccessSettingManager
      Parameters:
      protocol - Takes in a parameter of protocol
      allowedIp - Takes in a parameter of allowedIp
      allowedMask - Takes in a parameter of allowedMask
      srcNameIf - Takes in a parameter of srcNameIf
      Returns:
      boolean Returns a boolean
    • deleteIpv6MgntAccessSetting

      public boolean deleteIpv6MgntAccessSetting(AccessProtocol protocol, IPAddress allowedIp, int allowedPrefix, String srcNameIf)
      Information provided by the PKI file:
      
          \brief Delete the access configuration that matches protocol, allowed ip address, allowed prefix and nameIf
          
          \param protocol, ssh/telnet/http
          \param allowedIp, ip address
          \param allowedPrefix, ipv6 prefix
          \param srcNameIf, nameIf of the interface that allow remote access
          
          \return bool, value is true if the delete was successful, false if not.
          
              
      Specified by:
      deleteIpv6MgntAccessSetting in interface MgntAccessSettingManager
      Parameters:
      protocol - Takes in a parameter of protocol
      allowedIp - Takes in a parameter of allowedIp
      allowedPrefix - Takes in a parameter of allowedPrefix
      srcNameIf - Takes in a parameter of srcNameIf
      Returns:
      boolean Returns a boolean
    • addMgntAccessSetting

      public boolean addMgntAccessSetting(AccessProtocol protocol, IPAddress allowedIp, IPAddress allowedMask, String srcNameIf)
      Information provided by the PKI file:
      
          \brief Add the access configuration that matches protocol, allowed ip address, allowed mask and nameIf
          
          \param protocol, ssh/telnet/http
          \param allowedIp, ip address
          \param allowedMask, mask
          \param srcNameIf, nameIf of the interface that allow remote access
          
          \return bool, value is true if the add was successful, false if not.
          
              
      Specified by:
      addMgntAccessSetting in interface MgntAccessSettingManager
      Parameters:
      protocol - Takes in a parameter of protocol
      allowedIp - Takes in a parameter of allowedIp
      allowedMask - Takes in a parameter of allowedMask
      srcNameIf - Takes in a parameter of srcNameIf
      Returns:
      boolean Returns a boolean
    • getMgntAccessSettingAt

      public MgntAccessSetting getMgntAccessSettingAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the access setting a specified index
          
          \param index, index to retrive the access setting from.  Range (0, getMgntAccessSettingCount()).
          
          \return CMgntAccessSetting, value is the access setting a specified index.
          
              
      Specified by:
      getMgntAccessSettingAt in interface MgntAccessSettingManager
      Parameters:
      index - Takes in a parameter of index
      Returns:
      MgntAccessSetting Returns a MgntAccessSetting
    • getMgntAccessSettingCount

      public int getMgntAccessSettingCount()
      Information provided by the PKI file:
      
          \brief Return the number of access setting
          
          \return int, value is the number of access settings.
          
              
      Specified by:
      getMgntAccessSettingCount in interface MgntAccessSettingManager
      Returns:
      int Returns a int
    • setSshTimeout

      public void setSshTimeout(int timeout)
      Information provided by the PKI file:
      
          \brief Set the ssh timeout for ssh connection
          
          \param timeout, in minutes
          
              
      Specified by:
      setSshTimeout in interface MgntAccessSettingManager
      Parameters:
      timeout - Takes in a parameter of timeout
    • getSshTimeout

      public int getSshTimeout()
      Information provided by the PKI file:
      
          \brief Return the ssh timeout
          
          \return int, value is the ssh timeout.
          
              
      Specified by:
      getSshTimeout in interface MgntAccessSettingManager
      Returns:
      int Returns a int
    • setTelnetTimeout

      public void setTelnetTimeout(int timeout)
      Information provided by the PKI file:
      
          \brief Set the telnet timeout for telnet connection
          
          \param timeout, in minutes
          
              
      Specified by:
      setTelnetTimeout in interface MgntAccessSettingManager
      Parameters:
      timeout - Takes in a parameter of timeout
    • getTelnetTimeout

      public int getTelnetTimeout()
      Information provided by the PKI file:
      
          \brief Return the Telnet timeout
          
          \return int, value is the Telnet timeout.
          
              
      Specified by:
      getTelnetTimeout in interface MgntAccessSettingManager
      Returns:
      int Returns a int
    • allow

      public boolean allow(AccessProtocol protocol, IPAddress ipAddress, String srcNameIf)
      Information provided by the PKI file:
      
          \brief Check to see if the traffic that matches protocol, ipAddress into srcNameIf allowed or not
          
          \param protocol, ssh/telnet/http
          \param ipAddress, source ip address of the host
          \param srcNameIf, the nameif of the interface in which the host is trying to gain access into
          
          \return bool, value is true if the traffic that matches protocol, ipAddress into srcNameIf allowed, false if not.
          
              
      Specified by:
      allow in interface MgntAccessSettingManager
      Parameters:
      protocol - Takes in a parameter of protocol
      ipAddress - Takes in a parameter of ipAddress
      srcNameIf - Takes in a parameter of srcNameIf
      Returns:
      boolean Returns a boolean